<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NMEAParser: CNMEAParserPacket Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">NMEAParser
   </div>
   <div id="projectbrief">NMEA Parser Library - Monte Variakojis @VisualGPS</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="class_c_n_m_e_a_parser_packet-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">CNMEAParserPacket Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>This class will parse NMEA data packet and call its virtual processor methods.  
 <a href="class_c_n_m_e_a_parser_packet.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_n_m_e_a_parser_packet_8h_source.html">NMEAParserPacket.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CNMEAParserPacket:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_c_n_m_e_a_parser_packet.png" usemap="#CNMEAParserPacket_map" alt=""/>
  <map id="CNMEAParserPacket_map" name="CNMEAParserPacket_map">
<area href="class_c_n_m_e_a_parser.html" title="This class will parse NMEA data, store its data and report that it has received data. " alt="CNMEAParser" shape="rect" coords="0,56,134,80"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7d991caf98d5980af0c315dc1a128ada"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_n_m_e_a_parser_packet.html#a7d991caf98d5980af0c315dc1a128ada">CNMEAParserPacket</a> ()</td></tr>
<tr class="separator:a7d991caf98d5980af0c315dc1a128ada"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72eb9081263ab65fd5812155544e69f8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_n_m_e_a_parser_packet.html#a72eb9081263ab65fd5812155544e69f8">~CNMEAParserPacket</a> ()</td></tr>
<tr class="separator:a72eb9081263ab65fd5812155544e69f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e4e876a492b6cd7e4665081da4ac443"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespace_c_n_m_e_a_parser_data.html#a88b2365ba47855c3b8cfb7dfd71d99a9">CNMEAParserData::ERROR_E</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_n_m_e_a_parser_packet.html#a1e4e876a492b6cd7e4665081da4ac443">ProcessNMEABuffer</a> (char *pData, size_t nBufferSize)</td></tr>
<tr class="memdesc:a1e4e876a492b6cd7e4665081da4ac443"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses pData for NMEA data.  <a href="#a1e4e876a492b6cd7e4665081da4ac443">More...</a><br /></td></tr>
<tr class="separator:a1e4e876a492b6cd7e4665081da4ac443"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1355525f6efa8d5584f856c2b59309a3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_n_m_e_a_parser_packet.html#a1355525f6efa8d5584f856c2b59309a3">Reset</a> (void)</td></tr>
<tr class="memdesc:a1355525f6efa8d5584f856c2b59309a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the parser.  <a href="#a1355525f6efa8d5584f856c2b59309a3">More...</a><br /></td></tr>
<tr class="separator:a1355525f6efa8d5584f856c2b59309a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbe37d75ecda1cda2ddd3245eea6db8a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_n_m_e_a_parser_packet.html#acbe37d75ecda1cda2ddd3245eea6db8a">OnError</a> (<a class="el" href="namespace_c_n_m_e_a_parser_data.html#a88b2365ba47855c3b8cfb7dfd71d99a9">CNMEAParserData::ERROR_E</a> nError, char *pCmd)</td></tr>
<tr class="memdesc:acbe37d75ecda1cda2ddd3245eea6db8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is called whenever there is a parsing error.  <a href="#acbe37d75ecda1cda2ddd3245eea6db8a">More...</a><br /></td></tr>
<tr class="separator:acbe37d75ecda1cda2ddd3245eea6db8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a1da7aea129ff4ca1eefb07c82df30ecf"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespace_c_n_m_e_a_parser_data.html#a88b2365ba47855c3b8cfb7dfd71d99a9">CNMEAParserData::ERROR_E</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_n_m_e_a_parser_packet.html#a1da7aea129ff4ca1eefb07c82df30ecf">ProcessRxCommand</a> (char *pCmd, char *pData)=0</td></tr>
<tr class="memdesc:a1da7aea129ff4ca1eefb07c82df30ecf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Redefine this method to process valid NMEA commands. Make sure that you honer the parameters below.  <a href="#a1da7aea129ff4ca1eefb07c82df30ecf">More...</a><br /></td></tr>
<tr class="separator:a1da7aea129ff4ca1eefb07c82df30ecf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88297683d6572eb9134fb5fea008ee2f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_n_m_e_a_parser_packet.html#a88297683d6572eb9134fb5fea008ee2f">TimeTag</a> (void)</td></tr>
<tr class="memdesc:a88297683d6572eb9134fb5fea008ee2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is called when receiving the start of message of the NMEA packet.  <a href="#a88297683d6572eb9134fb5fea008ee2f">More...</a><br /></td></tr>
<tr class="separator:a88297683d6572eb9134fb5fea008ee2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:afe77fde5b858aa74d2393ebdb9699cfc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_n_m_e_a_parser_packet.html#afe77fde5b858aa74d2393ebdb9699cfc">PARSE_STATE</a> { <br />
&#160;&#160;<a class="el" href="class_c_n_m_e_a_parser_packet.html#afe77fde5b858aa74d2393ebdb9699cfcacb193a6edd3d7ae47fb2e1fcb00ac4f5">PARSE_STATE_SOM</a> = 0, 
<a class="el" href="class_c_n_m_e_a_parser_packet.html#afe77fde5b858aa74d2393ebdb9699cfca9165613822692f404e6b228e1444c7bb">PARSE_STATE_CMD</a>, 
<a class="el" href="class_c_n_m_e_a_parser_packet.html#afe77fde5b858aa74d2393ebdb9699cfca95bb69da399f4dcc40d1fab5837447be">PARSE_STATE_DATA</a>, 
<a class="el" href="class_c_n_m_e_a_parser_packet.html#afe77fde5b858aa74d2393ebdb9699cfcacce03973d245e26c195a2e17d1a313a2">PARSE_STATE_CHECKSUM_1</a>, 
<br />
&#160;&#160;<a class="el" href="class_c_n_m_e_a_parser_packet.html#afe77fde5b858aa74d2393ebdb9699cfca5c763e8aac399dad22cc332738adb2ba">PARSE_STATE_CHECKSUM_2</a>
<br />
 }</td></tr>
<tr class="separator:afe77fde5b858aa74d2393ebdb9699cfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:acf2463f2805b2eceabe165cef3554521"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_c_n_m_e_a_parser_packet.html#afe77fde5b858aa74d2393ebdb9699cfc">PARSE_STATE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_n_m_e_a_parser_packet.html#acf2463f2805b2eceabe165cef3554521">m_nState</a></td></tr>
<tr class="memdesc:acf2463f2805b2eceabe165cef3554521"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current NMEA parse state.  <a href="#acf2463f2805b2eceabe165cef3554521">More...</a><br /></td></tr>
<tr class="separator:acf2463f2805b2eceabe165cef3554521"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ccd83fa6c892e952ce9e28bb8b63d94"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_n_m_e_a_parser_packet.html#a2ccd83fa6c892e952ce9e28bb8b63d94">m_u8Checksum</a></td></tr>
<tr class="memdesc:a2ccd83fa6c892e952ce9e28bb8b63d94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculated NMEA sentence checksum.  <a href="#a2ccd83fa6c892e952ce9e28bb8b63d94">More...</a><br /></td></tr>
<tr class="separator:a2ccd83fa6c892e952ce9e28bb8b63d94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa20e500025c0e6d96ec3447111d0c5af"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_n_m_e_a_parser_packet.html#aa20e500025c0e6d96ec3447111d0c5af">m_u8ReceivedChecksum</a></td></tr>
<tr class="memdesc:aa20e500025c0e6d96ec3447111d0c5af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Received NMEA sentence checksum (if exists)  <a href="#aa20e500025c0e6d96ec3447111d0c5af">More...</a><br /></td></tr>
<tr class="separator:aa20e500025c0e6d96ec3447111d0c5af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8b735f17e56b8404f465671f5df0248"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_n_m_e_a_parser_packet.html#aa8b735f17e56b8404f465671f5df0248">m_nIndex</a></td></tr>
<tr class="memdesc:aa8b735f17e56b8404f465671f5df0248"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index used for command and data.  <a href="#aa8b735f17e56b8404f465671f5df0248">More...</a><br /></td></tr>
<tr class="separator:aa8b735f17e56b8404f465671f5df0248"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40389a7b00aed504ef6384d17e546f41"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_n_m_e_a_parser_packet.html#a40389a7b00aed504ef6384d17e546f41">m_pCommand</a> [CNMEAParserData::c_uMaxCmdLen]</td></tr>
<tr class="memdesc:a40389a7b00aed504ef6384d17e546f41"><td class="mdescLeft">&#160;</td><td class="mdescRight">NMEA command.  <a href="#a40389a7b00aed504ef6384d17e546f41">More...</a><br /></td></tr>
<tr class="separator:a40389a7b00aed504ef6384d17e546f41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c2916ccc079be9da25d6446f5650214"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_n_m_e_a_parser_packet.html#a6c2916ccc079be9da25d6446f5650214">m_pData</a> [CNMEAParserData::c_uMaxDataLen]</td></tr>
<tr class="memdesc:a6c2916ccc079be9da25d6446f5650214"><td class="mdescLeft">&#160;</td><td class="mdescRight">NMEA data.  <a href="#a6c2916ccc079be9da25d6446f5650214">More...</a><br /></td></tr>
<tr class="separator:a6c2916ccc079be9da25d6446f5650214"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class will parse NMEA data packet and call its virtual processor methods. </p>
<p>Below describes the <a class="el" href="class_c_n_m_e_a_parser_packet.html#a1e4e876a492b6cd7e4665081da4ac443" title="Parses pData for NMEA data. ">ProcessNMEABuffer()</a> methods state machine. It's whole goal is to connect data, build a command and call ProcessRxCommand robustly.</p>
<div class="dotgraph">
<img src="dot_inline_dotgraph_1.png" alt="dot_inline_dotgraph_1.png" border="0" usemap="#dot_inline_dotgraph_1.map"/>
<map name="dot_inline_dotgraph_1.map" id="dot_inline_dotgraph_1.map"><area shape="poly" id="node1" href="class_c_n_m_e_a_parser_packet.html#a1da7aea129ff4ca1eefb07c82df30ecf" title="PARSE_STATE_SOM" alt="" coords="392,29,388,22,375,15,355,10,330,7,303,5,275,7,250,10,230,15,218,22,213,29,218,37,230,43,250,49,275,52,303,53,330,52,355,49,375,43,388,37"/>
<area shape="poly" id="node2" href="class_c_n_m_e_a_parser_packet.html#a1da7aea129ff4ca1eefb07c82df30ecf" title="PARSE_STATE_CMD" alt="" coords="254,127,250,119,237,113,217,107,193,104,165,103,138,104,113,107,94,113,81,119,77,127,81,134,94,141,113,146,138,149,165,151,193,149,217,146,237,141,250,134"/>
<area shape="poly" id="node3" href="class_c_n_m_e_a_parser_packet.html#a1da7aea129ff4ca1eefb07c82df30ecf" title="PARSE_STATE_DATA" alt="" coords="257,224,253,217,240,210,219,205,194,201,165,200,137,201,111,205,91,210,78,217,73,224,78,231,91,238,111,243,137,247,165,248,194,247,219,243,240,238,253,231"/>
<area shape="poly" id="node4" href="class_c_n_m_e_a_parser_packet.html#a1da7aea129ff4ca1eefb07c82df30ecf" title="PARSE_STATE_CHECKSUM_1" alt="" coords="365,321,359,314,342,307,314,302,280,299,241,297,203,299,168,302,141,307,123,314,117,321,123,329,141,335,168,341,203,344,241,345,280,344,314,341,342,335,359,329"/>
<area shape="rect" id="node6" href="class_c_n_m_e_a_parser_packet.html#a1da7aea129ff4ca1eefb07c82df30ecf" title="Call Virtual ProcessRxCommand" alt="" coords="210,520,422,568"/>
<area shape="poly" id="node5" href="class_c_n_m_e_a_parser_packet.html#a1da7aea129ff4ca1eefb07c82df30ecf" title="PARSE_STATE_CHECKSUM_2" alt="" coords="440,447,434,439,416,433,389,427,354,424,316,423,278,424,243,427,216,433,198,439,192,447,198,454,216,461,243,466,278,469,316,471,354,469,389,466,416,461,434,454"/>
</map>
<div class="caption">
Receive Packet State Machine</div>
</div>
 
<p class="definition">Definition at line <a class="el" href="_n_m_e_a_parser_packet_8h_source.html#l00066">66</a> of file <a class="el" href="_n_m_e_a_parser_packet_8h_source.html">NMEAParserPacket.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="afe77fde5b858aa74d2393ebdb9699cfc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe77fde5b858aa74d2393ebdb9699cfc">&#9670;&nbsp;</a></span>PARSE_STATE</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="class_c_n_m_e_a_parser_packet.html#afe77fde5b858aa74d2393ebdb9699cfc">CNMEAParserPacket::PARSE_STATE</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="afe77fde5b858aa74d2393ebdb9699cfcacb193a6edd3d7ae47fb2e1fcb00ac4f5"></a>PARSE_STATE_SOM&#160;</td><td class="fielddoc"><p>Search for start of message. </p>
</td></tr>
<tr><td class="fieldname"><a id="afe77fde5b858aa74d2393ebdb9699cfca9165613822692f404e6b228e1444c7bb"></a>PARSE_STATE_CMD&#160;</td><td class="fielddoc"><p>Get command. </p>
</td></tr>
<tr><td class="fieldname"><a id="afe77fde5b858aa74d2393ebdb9699cfca95bb69da399f4dcc40d1fab5837447be"></a>PARSE_STATE_DATA&#160;</td><td class="fielddoc"><p>Get data. </p>
</td></tr>
<tr><td class="fieldname"><a id="afe77fde5b858aa74d2393ebdb9699cfcacce03973d245e26c195a2e17d1a313a2"></a>PARSE_STATE_CHECKSUM_1&#160;</td><td class="fielddoc"><p>Get first checksum character. </p>
</td></tr>
<tr><td class="fieldname"><a id="afe77fde5b858aa74d2393ebdb9699cfca5c763e8aac399dad22cc332738adb2ba"></a>PARSE_STATE_CHECKSUM_2&#160;</td><td class="fielddoc"><p>get second checksum character </p>
</td></tr>
</table>

<p class="definition">Definition at line <a class="el" href="_n_m_e_a_parser_packet_8h_source.html#l00070">70</a> of file <a class="el" href="_n_m_e_a_parser_packet_8h_source.html">NMEAParserPacket.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7d991caf98d5980af0c315dc1a128ada"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d991caf98d5980af0c315dc1a128ada">&#9670;&nbsp;</a></span>CNMEAParserPacket()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CNMEAParserPacket::CNMEAParserPacket </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_n_m_e_a_parser_packet_8cpp_source.html#l00028">28</a> of file <a class="el" href="_n_m_e_a_parser_packet_8cpp_source.html">NMEAParserPacket.cpp</a>.</p>

</div>
</div>
<a id="a72eb9081263ab65fd5812155544e69f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72eb9081263ab65fd5812155544e69f8">&#9670;&nbsp;</a></span>~CNMEAParserPacket()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CNMEAParserPacket::~CNMEAParserPacket </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_n_m_e_a_parser_packet_8cpp_source.html#l00037">37</a> of file <a class="el" href="_n_m_e_a_parser_packet_8cpp_source.html">NMEAParserPacket.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="acbe37d75ecda1cda2ddd3245eea6db8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbe37d75ecda1cda2ddd3245eea6db8a">&#9670;&nbsp;</a></span>OnError()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void CNMEAParserPacket::OnError </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespace_c_n_m_e_a_parser_data.html#a88b2365ba47855c3b8cfb7dfd71d99a9">CNMEAParserData::ERROR_E</a>&#160;</td>
          <td class="paramname"><em>nError</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>pCmd</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This method is called whenever there is a parsing error. </p>
<p>Redefine this method to capture errors.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pCmd</td><td>Pointer to NMEA command that caused the error. Please note that this parameter may be NULL of not completely defined. Use with caution. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="_n_m_e_a_parser_packet_8h_source.html#l00116">116</a> of file <a class="el" href="_n_m_e_a_parser_packet_8h_source.html">NMEAParserPacket.h</a>.</p>

</div>
</div>
<a id="a1e4e876a492b6cd7e4665081da4ac443"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e4e876a492b6cd7e4665081da4ac443">&#9670;&nbsp;</a></span>ProcessNMEABuffer()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespace_c_n_m_e_a_parser_data.html#a88b2365ba47855c3b8cfb7dfd71d99a9">CNMEAParserData::ERROR_E</a> CNMEAParserPacket::ProcessNMEABuffer </td>
          <td>(</td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>pData</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>nBufferSize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Parses pData for NMEA data. </p>
<p>This method will parse pData for NMEA data.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pData</td><td>Pointer to buffer to parse </td></tr>
    <tr><td class="paramname">nBufferSize</td><td>Number of bytes in pData to process. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="namespace_c_n_m_e_a_parser_data.html#a88b2365ba47855c3b8cfb7dfd71d99a9">CNMEAParserData::ERROR_E</a>, if successful, ERROR_OK is returned. </dd></dl>

<p class="definition">Definition at line <a class="el" href="_n_m_e_a_parser_packet_8cpp_source.html#l00041">41</a> of file <a class="el" href="_n_m_e_a_parser_packet_8cpp_source.html">NMEAParserPacket.cpp</a>.</p>

</div>
</div>
<a id="a1da7aea129ff4ca1eefb07c82df30ecf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1da7aea129ff4ca1eefb07c82df30ecf">&#9670;&nbsp;</a></span>ProcessRxCommand()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="namespace_c_n_m_e_a_parser_data.html#a88b2365ba47855c3b8cfb7dfd71d99a9">CNMEAParserData::ERROR_E</a> CNMEAParserPacket::ProcessRxCommand </td>
          <td>(</td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>pCmd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>pData</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Redefine this method to process valid NMEA commands. Make sure that you honer the parameters below. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pCmd</td><td>Pointer to the NMEA command string </td></tr>
    <tr><td class="paramname">pData</td><td>Comma separated data that belongs to the command </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns <a class="el" href="namespace_c_n_m_e_a_parser_data.html#a88b2365ba47855c3b8cfb7dfd71d99a9a1cc61da760414f811f7163bb5ecf5470" title="No error, operation successful. ">CNMEAParserData::ERROR_OK</a> If successful </dd></dl>

<p>Implemented in <a class="el" href="class_c_n_m_e_a_parser.html#ac661ec8031503ce2bb324ee011debea4">CNMEAParser</a>.</p>

</div>
</div>
<a id="a1355525f6efa8d5584f856c2b59309a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1355525f6efa8d5584f856c2b59309a3">&#9670;&nbsp;</a></span>Reset()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CNMEAParserPacket::Reset </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reset the parser. </p>
<p>A reset will restart the parser to start to look for the start of message. </p>

<p class="definition">Definition at line <a class="el" href="_n_m_e_a_parser_packet_8cpp_source.html#l00170">170</a> of file <a class="el" href="_n_m_e_a_parser_packet_8cpp_source.html">NMEAParserPacket.cpp</a>.</p>

</div>
</div>
<a id="a88297683d6572eb9134fb5fea008ee2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88297683d6572eb9134fb5fea008ee2f">&#9670;&nbsp;</a></span>TimeTag()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void CNMEAParserPacket::TimeTag </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This method is called when receiving the start of message of the NMEA packet. </p>
<p>If you need to time tag your NMEA sentences, redefine this method to allow you to capture when the SOM was received. You can then use the <a class="el" href="class_c_n_m_e_a_parser_packet.html#a1da7aea129ff4ca1eefb07c82df30ecf" title="Redefine this method to process valid NMEA commands. Make sure that you honer the parameters below...">ProcessRxCommand()</a> method to capture the NMEA command that this time-tag belongs to. </p>

<p class="definition">Definition at line <a class="el" href="_n_m_e_a_parser_packet_8h_source.html#l00137">137</a> of file <a class="el" href="_n_m_e_a_parser_packet_8h_source.html">NMEAParserPacket.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa8b735f17e56b8404f465671f5df0248"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8b735f17e56b8404f465671f5df0248">&#9670;&nbsp;</a></span>m_nIndex</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t CNMEAParserPacket::m_nIndex</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Index used for command and data. </p>

<p class="definition">Definition at line <a class="el" href="_n_m_e_a_parser_packet_8h_source.html#l00083">83</a> of file <a class="el" href="_n_m_e_a_parser_packet_8h_source.html">NMEAParserPacket.h</a>.</p>

</div>
</div>
<a id="acf2463f2805b2eceabe165cef3554521"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf2463f2805b2eceabe165cef3554521">&#9670;&nbsp;</a></span>m_nState</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_c_n_m_e_a_parser_packet.html#afe77fde5b858aa74d2393ebdb9699cfc">PARSE_STATE</a> CNMEAParserPacket::m_nState</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Current NMEA parse state. </p>

<p class="definition">Definition at line <a class="el" href="_n_m_e_a_parser_packet_8h_source.html#l00080">80</a> of file <a class="el" href="_n_m_e_a_parser_packet_8h_source.html">NMEAParserPacket.h</a>.</p>

</div>
</div>
<a id="a40389a7b00aed504ef6384d17e546f41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40389a7b00aed504ef6384d17e546f41">&#9670;&nbsp;</a></span>m_pCommand</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">char CNMEAParserPacket::m_pCommand[CNMEAParserData::c_uMaxCmdLen]</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>NMEA command. </p>

<p class="definition">Definition at line <a class="el" href="_n_m_e_a_parser_packet_8h_source.html#l00084">84</a> of file <a class="el" href="_n_m_e_a_parser_packet_8h_source.html">NMEAParserPacket.h</a>.</p>

</div>
</div>
<a id="a6c2916ccc079be9da25d6446f5650214"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c2916ccc079be9da25d6446f5650214">&#9670;&nbsp;</a></span>m_pData</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">char CNMEAParserPacket::m_pData[CNMEAParserData::c_uMaxDataLen]</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>NMEA data. </p>

<p class="definition">Definition at line <a class="el" href="_n_m_e_a_parser_packet_8h_source.html#l00085">85</a> of file <a class="el" href="_n_m_e_a_parser_packet_8h_source.html">NMEAParserPacket.h</a>.</p>

</div>
</div>
<a id="a2ccd83fa6c892e952ce9e28bb8b63d94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ccd83fa6c892e952ce9e28bb8b63d94">&#9670;&nbsp;</a></span>m_u8Checksum</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t CNMEAParserPacket::m_u8Checksum</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Calculated NMEA sentence checksum. </p>

<p class="definition">Definition at line <a class="el" href="_n_m_e_a_parser_packet_8h_source.html#l00081">81</a> of file <a class="el" href="_n_m_e_a_parser_packet_8h_source.html">NMEAParserPacket.h</a>.</p>

</div>
</div>
<a id="aa20e500025c0e6d96ec3447111d0c5af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa20e500025c0e6d96ec3447111d0c5af">&#9670;&nbsp;</a></span>m_u8ReceivedChecksum</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t CNMEAParserPacket::m_u8ReceivedChecksum</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Received NMEA sentence checksum (if exists) </p>

<p class="definition">Definition at line <a class="el" href="_n_m_e_a_parser_packet_8h_source.html#l00082">82</a> of file <a class="el" href="_n_m_e_a_parser_packet_8h_source.html">NMEAParserPacket.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>D:/Source/GitHub/NMEAParser/Software/NMEAParserLib/<a class="el" href="_n_m_e_a_parser_packet_8h_source.html">NMEAParserPacket.h</a></li>
<li>D:/Source/GitHub/NMEAParser/Software/NMEAParserLib/<a class="el" href="_n_m_e_a_parser_packet_8cpp_source.html">NMEAParserPacket.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
